Other Alarm-Related Properties

Several CygNet Properties on many CygNet Studio tools and controls are involved in the display of alarm information. These properties are described in the following table.

Property	Description
[AlarmElement]	[AlarmElement] specifies the element of the object in which the point's alarm status is displayed. The options vary depending upon the tool. For example, with a Text Tool or the Ribbon Tool the alarm status can be shown in the foreground color (text), background color, or none. With a Linear Gauge Tool or Angular Gauge Tool the options are the pointer color or background color. If set to None, the alarm status is not shown. This property is not shown if the [StateColorMode] property is set to a value other than 1 - Single.
[AllowAlarmAck]	[AllowAlarmAck] enables display of the Acknowledge Alarm option on the Context Menu when the object’s point has an unacknowledged alarm. [DisplayAlarmAck] must also be set to true. Default is 1 - Yes.
[BlinkColor]	[BlinkColor] specifies the color that alternates with the alarm color when the [DisplayAlarmAck] property is set to 1 - Yes and the point’s alarm is unacknowledged. Default is Automatic. Be careful not to set the blink color to an alarm color or the blinking will not be visible. For example, if the blink color is red and the alarm color is red, the object will not appear to be blinking because the red blinking red will look like solid red. Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'
[CustomStateColors]	[CustomStateColors] specifies custom point state colors. Click … to view the Configure Point State Colors dialog box from where you can configure colors to use. See Customizing Point State Colors for more information. If defined for TheView, this property specifies the custom point state status colors that can be applied to all objects. If defined for an object, this property specifies the custom point status colors for the instance of the object. An object’s custom colors take precedence over those of TheView. If an object does not have its own custom state colors, TheView’s custom state colors will apply to the object. That is, TheView’s custom state colors serve as defaults. Note: You cannot set this property via script.
[DisplayAlarmAck]	[DisplayAlarmAck] enables the display of the unacknowledged alarm state. If set to true, the object will blink when the object’s point has an unacknowledged alarm. The default is 0 - No. When this property is enabled and the condition is true, the user can acknowledge the alarm from the object’s Context Menu if the [AllowAlarmAck] property is set to 1 - Yes. When blinking is enabled, the method in which the blink is displayed is determined by the value of the blink attribute configured in the PointSchemes element of the CvsMetadata.xml file. See Understanding the CVS Metadata File for more information. Note: Alarm blinking is available only for points created using the CygNet Enhanced Point Scheme (Point Scheme number 1 - 15). The blinking feature is not available for points created using the default CygNet Standard Point Scheme (Point Scheme number 0).
[StateColorEvaluation]	[StateColorEvaluation] specifies whether the object’s color is based on its point state or its alarm state. Options are 0 - Point State and 1 - Alarm State or 1 - ePOINT_STATE and 2 - eALARM_CONDITION. The default is 0 - Point State or 1 - ePOINT_STATE.
[StateColorMode]	[StateColorMode] Specifies if and how the object will show the alarm point’s state color: shown in a single color (1 - Single), dual colors (2 - Dual), or not at all (0 - Off). The default is Single. Options include: Off (0 - eSTATECOLORMODE_OFF) Single Color (1 - eSTATECOLORMODE_SINGLE) Dual Colors (2 - eSTATECOLORMODE_DUAL) Most tools have a Single mode. That is, they can reflect the point state color in a single element. The element is defined by an object’s [AlarmElement] property to specify if the state color will be shown in the object’s foreground or background. Objects that have [AlarmElement] options of both Foreground Color and Background Color, such as the Text Tool or a closed shape (ellipse, rectangle, polyline), can be configured using the [StateColorMode] property to show the point state color in dual mode; that is, both the Foreground and Background. For tools with a Dual mode, you must select the foreground and background colors using the [UseCustomStateColors] property. The default is 1 - eOFF. Options include: 1 - eOFF 2 - eSINGLE_FOREGROUND 3 - eSINGLE_BACKGROUND 4 - eDUAL
[UseCustomStateColors]	[UseCustomStateColors] enables the use of the [CustomStateColors]. For TheView, this property enables use of TheView’s [CustomStateColors]. Default is 1 - Yes. For objects, this property enables use of the object’s [CustomStateColors]. Default is 1 - Yes. If this property is set to 0 - No for an object and is set to 1 - Yes for TheView, the object will use the custom state colors of TheView.

Property

Description

[AlarmElement]

[AlarmElement] specifies the element of the object in which the point's alarm status is displayed. The options vary depending upon the tool. For example, with a Text Tool or the Ribbon Tool the alarm status can be shown in the foreground color (text), background color, or none. With a Linear Gauge Tool or Angular Gauge Tool the options are the pointer color or background color. If set to None, the alarm status is not shown. This property is not shown if the [StateColorMode] property is set to a value other than 1 - Single.

[AllowAlarmAck]

[AllowAlarmAck] enables display of the Acknowledge Alarm option on the Context Menu when the object’s point has an unacknowledged alarm. [DisplayAlarmAck] must also be set to true. Default is 1 - Yes.

[BlinkColor]

[BlinkColor] specifies the color that alternates with the alarm color when the [DisplayAlarmAck] property is set to 1 - Yes and the point’s alarm is unacknowledged. Default is Automatic. Be careful not to set the blink color to an alarm color or the blinking will not be visible. For example, if the blink color is red and the alarm color is red, the object will not appear to be blinking because the red blinking red will look like solid red.

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

[CustomStateColors]

[CustomStateColors] specifies custom point state colors. Click … to view the Configure Point State Colors dialog box from where you can configure colors to use. See Customizing Point State Colors for more information.

If defined for TheView, this property specifies the custom point state status colors that can be applied to all objects.
If defined for an object, this property specifies the custom point status colors for the instance of the object. An object’s custom colors take precedence over those of TheView. If an object does not have its own custom state colors, TheView’s custom state colors will apply to the object. That is, TheView’s custom state colors serve as defaults.

Note: You cannot set this property via script.

[DisplayAlarmAck]

[DisplayAlarmAck] enables the display of the unacknowledged alarm state. If set to true, the object will blink when the object’s point has an unacknowledged alarm. The default is 0 - No. When this property is enabled and the condition is true, the user can acknowledge the alarm from the object’s Context Menu if the [AllowAlarmAck] property is set to 1 - Yes.

When blinking is enabled, the method in which the blink is displayed is determined by the value of the blink attribute configured in the PointSchemes element of the CvsMetadata.xml file. See Understanding the CVS Metadata File for more information.

Note: Alarm blinking is available only for points created using the CygNet Enhanced Point Scheme (Point Scheme number 1 - 15). The blinking feature is not available for points created using the default CygNet Standard Point Scheme (Point Scheme number 0).

[StateColorEvaluation]

[StateColorEvaluation] specifies whether the object’s color is based on its point state or its alarm state. Options are 0 - Point State and 1 - Alarm State or 1 - ePOINT_STATE and 2 - eALARM_CONDITION. The default is 0 - Point State or 1 - ePOINT_STATE.

[StateColorMode]

[StateColorMode] Specifies if and how the object will show the alarm point’s state color: shown in a single color (1 - Single), dual colors (2 - Dual), or not at all (0 - Off). The default is Single. Options include:

Off (0 - eSTATECOLORMODE_OFF)
Single Color (1 - eSTATECOLORMODE_SINGLE)
Dual Colors (2 - eSTATECOLORMODE_DUAL)

Most tools have a Single mode. That is, they can reflect the point state color in a single element. The element is defined by an object’s [AlarmElement] property to specify if the state color will be shown in the object’s foreground or background. Objects that have [AlarmElement] options of both Foreground Color and Background Color, such as the Text Tool or a closed shape (ellipse, rectangle, polyline), can be configured using the [StateColorMode] property to show the point state color in dual mode; that is, both the Foreground and Background. For tools with a Dual mode, you must select the foreground and background colors using the [UseCustomStateColors] property. The default is 1 - eOFF. Options include:

1 - eOFF
2 - eSINGLE_FOREGROUND
3 - eSINGLE_BACKGROUND
4 - eDUAL

[UseCustomStateColors]

[UseCustomStateColors] enables the use of the [CustomStateColors].

For TheView, this property enables use of TheView’s [CustomStateColors]. Default is 1 - Yes.
For objects, this property enables use of the object’s [CustomStateColors]. Default is 1 - Yes.

If this property is set to 0 - No for an object and is set to 1 - Yes for TheView, the object will use the custom state colors of TheView.